package com.zjj.learn.algorithmPlus.segment1.queue;

import java.util.Iterator;

/**
 * 基于环形数组实现队列
 * 环形数组有 head 和 tail ，head 表示第一个真实数据，tail 不存储数据，表示队列的尾部
 * 使用环形数组的好处是，任何一盒位置都可以作为新的 head 和 tail
 *
 * @author zjj_admin
 */
public class RingArrayQueue1<E> implements Queue<E>, Iterable<E> {

    /**
     * 队列元素
     */
    private final E[] array;
    /**
     * 头结点的索引
     */
    private int head;
    /**
     * 尾结点的索引
     */
    private int tail;

    /**
     * 队列元素个数
     */
    private int size;

    /**
     * 队列的容量，最大值为 1000
     */
    private int capacity = 10000;


    {
        // 代码块，初始化数据
        head = 0;
        tail = 0;
        size = 0;
    }

    @SuppressWarnings("all")
    public RingArrayQueue1(int capacity) {
        if (capacity < 0 || capacity > 10000) {
            throw new IndexOutOfBoundsException("capacity 不符合规范");
        }
        this.capacity = capacity;
        //初始化数组，多余的一个用于存放 tail 指针
        array = (E[]) new Object[capacity + 1];
    }

    @SuppressWarnings("all")
    public RingArrayQueue1() {
        array = (E[]) new Object[capacity + 1];
    }

    /**
     * 添加新节点，就将当前的 tail 位置存储数据，并且将 tail 向后移动一位
     *
     * @param value 添加数据
     * @return
     */
    @Override
    public boolean offer(E value) {
        if (isFull()) {
            return false;
        }
        array[tail] = value;
        tail = (tail + 1) % array.length;
        size++;
        return true;
    }

    /**
     * 移除第一个节点，获取当前 head 节点的数据，并将 head 节点向后移动一位
     *
     * @return
     */
    @Override
    public E poll() {
        if (isEmpty()) {
            return null;
        }
        E value = array[head];
        head = (head + 1) % array.length;
        size--;
        return value;
    }

    @Override
    public E peek() {
        if (isEmpty()) {
            return null;
        }
        return array[head];
    }

    @Override
    public boolean isEmpty() {
        return size == 0;
    }

    /**
     * 这里当队列满时
     *
     * @return
     */
    @Override
    public boolean isFull() {
        return size == array.length - 1;
    }

    @Override
    public int size() {
        return size;
    }

    @Override
    public Iterator<E> iterator() {
        return new Iterator<E>() {
            int index = head;
            int count = 0;

            @Override
            public boolean hasNext() {
                return count < size;
            }

            @Override
            public E next() {
                E value = array[index];
                index = (index + 1) % array.length;
                count++;
                return value;
            }
        };
    }
}
